home *** CD-ROM | disk | FTP | other *** search
/ Collection of Tools & Utilities / Collection of Tools and Utilities.iso / sound / vocpak20.zip / VP.DOC < prev    next >
Text File  |  1993-09-01  |  8KB  |  195 lines
  1.                                   VOCPACK
  2.                                      
  3.                       Lossless sound file compressor
  4.                      Copyright (C) 1993 Nicola Ferioli
  5.  
  6.  
  7. File:     VP.DOC
  8. Version:  2.0
  9. Date:     01 September 1993
  10.  
  11.  
  12. ===========================================================================
  13.  
  14. 1  -  INTRODUCTION
  15.  
  16.  
  17. Vocpack is a compressor/decompressor for 8-bit and 16-bit digital sound
  18. files using a lossless algorithm; it is useful to save disk space without
  19. degrading sound quality.
  20. Vocpack is available in two forms: a command-line version and a library of
  21. functions which can be called from C programs (see LIB.DOC).
  22.  
  23. Any PCM sound can be compressed and it isn't necessary to strip file
  24. headers before compressing since the method used is not lossy.
  25. The typical compression ratio (compressed size / original size) with 8-bit
  26. files goes from 0,8 for sounds sampled at 11 KHz to 0,4 for 44 Khz ones
  27. (full-power sounds; low volume recordings and human voice give a better
  28. ratio). The best results are obtained with 44 KHz sounds: general-purpose
  29. archivers create files that can be twice longer than the output of Vocpack.
  30. The compression ratio for 16-bit files varies from 0,9 to 0,6.
  31. You can obtain smaller values using lossy compressors but if your goal is
  32. to keep the sound quality unaltered you should use a lossless program like
  33. Vocpack.
  34.  
  35. .MOD and .ST files are not compressed very well, since they contain a lot
  36. of sequencing information and the sound is sampled at a low frequency; in
  37. this case the files created by Vocpack could be slightly bigger than the
  38. ones produced by general-purpose compression programs.
  39.  
  40.  
  41. ===========================================================================
  42.  
  43. 2  -  WHAT'S NEW IN VERSION 2.0
  44.  
  45.  
  46. VOCPACK 2.0
  47. - is faster: compresses and decompresses in less than 1/2 of the time
  48.   employed by version 1.0; with some files just 1/4 of that time;
  49. - compression ratio is similar, often slightly better;
  50. - compresses 16-bit sounds;
  51. - uses 386 processor instructions for best performance;
  52. - can detect automatically the kind of data contained in VOC and WAVE
  53.   files;
  54. - the original file name is stored in the compressed file, so it can be
  55.   restored when expanding;
  56. - the command-line version has a new interface, easier to use; it can run
  57.   in less than 30 Kb of free memory and if there is more memory it is used
  58.   for disk buffering;
  59. - the new Library Version can be linked with C programs and it can do
  60.   realtime processing ( > 40 Kb per second on a 486DX/33 MHz); it requires
  61.   less than 8 Kb for code and data;
  62. - is not compatible with version 1.0: to uncompress old methods 0 and 1 you
  63.   must use the included program UNVP10.EXE.
  64.  
  65.  
  66. ===========================================================================
  67.  
  68. 3  -  VERSION NUMBER & REGISTRATION
  69.  
  70.  
  71. Vocpack is SHAREWARE software; you are free to copy and distribute
  72. unregistered versions of this program on condition that all files are
  73. included without any modification. No fee must be charged for such
  74. distribution.
  75.  
  76. The copyright displayed by the program VP.EXE contains the version number
  77. of Vocpack: '2.0 demo' for unregistered copies and '2.0' for registered
  78. ones. The unregistered version is for evaluation purpose and can only
  79. compress files; decompression is enabled when you register, so don't use
  80. version '2.0 demo' to store important files since you won't be able to
  81. extract them, unless you register. A warning message will be displayed
  82. every time you compress a file with an unregistered copy. See REGISTER.DOC
  83. for more information.
  84.  
  85.  
  86. ===========================================================================
  87.  
  88. 4  -  USAGE
  89.  
  90.  
  91. The command line of Vocpack has the form
  92.  
  93.    VP [-options] <inputfile> [outputfile]
  94.  
  95. You can run VP with no parameter to obtain a short summary of the available
  96. options.
  97. File names <inputfile> and [outputfile] can't contain wildcard characters,
  98. but may include drive and/or path.
  99.  
  100. The choice between packing and unpacking depends on the content of
  101. <inputfile>: if it's a file already compressed by Vocpack then it gets
  102. expanded, otherwise it gets compressed.
  103. If [outputfile] is given then the new file created will have this name; the
  104. default output file name for compression, used if [outputname] is missing,
  105. is the same of <inputfile> with the extension changed to '.vp'; when
  106. unpacking the default is the original name of the file, stored in the
  107. header of the compressed file.
  108. For example,
  109.               VP SOUND.WAV        packs sound.wav to sound.vp
  110.               VP SOUND.VP         unpacks sound.vp back to sound.wav
  111.  
  112. 'Options' can be one or more of the following:
  113.  
  114.    i : display information about <inputfile>: compression method used,
  115.        original and compressed size, compression ratio;
  116.  
  117.    o : overwrite output file if it already exists; if this switch is not
  118.        present, Vocpack asks for confirmation before overwriting;
  119.    
  120.    q : quiet mode, don't display the progress indicator.
  121.    
  122. Options must be preceded by a '-' and can be placed anywhere on the command
  123. line; they can be uppercase or lowercase and they can be combined ('-oq' is
  124. the same of '-o -q').
  125.  
  126. When compressing, Vocpack needs to know the kind of data contained in the
  127. file (8 or 16 bit, mono or stereo ...); if the file is in VOC or WAVE
  128. format Vocpack tries to get such information from the file header,
  129. otherwise the user must supply them through the following command-line
  130. options:
  131.  
  132.    u : unsigned data;
  133.    
  134.    s : signed data;
  135.    
  136.    2 : stereo data (default: mono);
  137.    
  138.    6 : 16-bit data (default: 8-bit);
  139.    
  140.    1 : odd alignment (default: even); this switch specifies whether the
  141.        lower byte of a 16-bit sample is placed at an even or odd offset
  142.        from the beginning of the file.
  143.  
  144. If one or more of these options is present, autodetection is disabled.
  145. Remember that VOC files contain unsigned data; WAVE files use unsigned
  146. 8-bit samples and signed 16-bit samples with even alignment.
  147.  
  148. To decompress a file packed with Vocpack version 1.0 you must use the
  149. program UNVP10.EXE contained in this package: version 2.0 doesn't handle
  150. them to save memory (old methods used more than 100 Kbyte of data when
  151. expanding).
  152.  
  153.  
  154. ===========================================================================
  155.  
  156. 5  -  ERROR CODES
  157.  
  158.  
  159. When an error occurs, Vocpack returns one of the following error codes (DOS
  160. errorlevel):
  161.  
  162.   1 = bad command line; the help screen was displayed
  163.   2 = input file not found
  164.   3 = output file can't be created
  165.   4 = input file is not compressed with Vocpack (or bad version)
  166.   5 = user break
  167.   6 = out of memory (version 1.0 only)
  168.   7 = read error
  169.   8 = write error
  170.  
  171.  
  172. ===========================================================================
  173.  
  174. 6  -  MISCELLANEOUS THINGS
  175.  
  176.  
  177. Vocpack 2.0 requires at least a 386 processor to run.
  178.  
  179. This software is provided 'as is' with no express or implied warranty. The
  180. author is not liable for any loss of data or other damage caused by the use
  181. of this software.
  182.  
  183. Bugs, suggestions, etc. can be e-mailed to the Internet address at the end
  184. of this document.
  185.  
  186. This text contains trademarks registered by their respective owners.
  187.  
  188.  
  189. ===========================================================================
  190.  
  191. FERIOLI NICOLA                       Internet: ser1509@cdc835.cdc.polimi.it
  192. VIA BOEZIO 6                                (this might change during 1994)
  193. 21052 BUSTO ARSIZIO
  194. ITALY
  195.